• repo
  • readme
  • stackblitz

postbase

View on Github

    Topics:

  • postgresql
  • react
.

Simple PostgreSQL GUI for visualizing your databases ,tables and their column types

postbase
.
B

Languages

  • .
  • .
  • .
  • TypeScript98.3%
  • CSS1.0%
  • JavaScript0.7%

postbase readme

POSTBASE

An attempt at a Nodejs based PostgresSQL GUI

Main postbase image

Getting started

  • clone locally
  • have a running Postgres server
  • make sure you have a default Postgres with the settings
postgres({
        host: "localhost",
        user: "postgres",
        password: "postgres",
        database: "postgres",
      })

Connection url can be used but types generation only works on local database

```sh
npm install
npm run dev

hljs for best results build and run it first

sh
npm run build
npm start
```

To use the TypeORM + TypeGraphQL classes add an environment variable with your Gemini API key, its free for simple uses.

https://github.com/tigawanna/postbase/assets/72096712/50ff037e-7364-46ec-a226-e143aa583be4

The output types and classes are stored in the
pg directory

built using

  • Rakkasjs Vite frontend + Nodejs backend + useServerSideQuery data fetching hooks

  • Shadcn/UI + Tailwindcss Stylings and components

  • Postgresjs: low level ORM for PostgresSQL

  • kanel: Tool for generating typescript types from Postgres

  • Gemini AI To generate TypeORM + TypeGraphQL classes

  • Shikiji Syntax highlighter , used to style the code blocks
    image.png" alt="Shikiji highlighted code" />